<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ServiceUtils</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ServiceUtils</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A utility class to simplify the use of API services.</p>
		<p class="notes">
			Located in <a class="field" href="_Ads---Dfp---Util---ServiceUtils.php.html">/Ads/Dfp/Util/ServiceUtils.php</a> (line <span class="field">30</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<a href="#GET_BY_STATEMENT_METHOD_NAME_REGEX" title="details" class="const-name">GET_BY_STATEMENT_METHOD_NAME_REGEX</a> = 					<span class="var-type"> '/^get.*ByStatement$/'</span>

				</div>
								<div class="const-title">
					<a href="#INCOMPATIBLE_FILTER_TEXT_REGEX" title="details" class="const-name">INCOMPATIBLE_FILTER_TEXT_REGEX</a> = 					<span class="var-type">
      '/(?i)(?&lt;=^|\s)(LIMIT|OFFSET)(?=$|\s)/'</span>

				</div>
								<div class="const-title">
					<a href="#PAGE_SIZE" title="details" class="const-name">PAGE_SIZE</a> = 					<span class="var-type"> 500</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">array</span>
										<a href="#GetAllObjects" title="details" class="method-name">GetAllObjects</a>
											(<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>&nbsp;<span class="var-name">$service</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$filterText</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">array</span>
										<a href="#GetSomeObjects" title="details" class="method-name">GetSomeObjects</a>
											(<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>&nbsp;<span class="var-name">$service</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filterText</span>)
									</div>
								
																				</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodGetAllObjects" id="GetAllObjects"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method GetAllObjects</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all the objects from an account, using the service and method  name provided.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the objects retrieved from the service using the method</li>
				<li><span class="field">throws:</span> InvalidArgumentException if <var>$methodName</var> is not a      get*ByStatement method or the filterText contains the LIMIT or      OFFSET options</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">array</span>
		<span class="method-name">
			GetAllObjects
		</span>
					(<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>&nbsp;<span class="var-name">$service</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$filterText</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>
				<span class="var-name">$service</span><span class="var-description">: the service to use</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$methodName</span><span class="var-description">: the name of the method</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filterText</span><span class="var-description">: optional filter text which must not contain      the LIMIT or OFFSET options</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGetSomeObjects" id="GetSomeObjects"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method GetSomeObjects</span> (line <span class="line-number">117</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns some of the objects from an account, using the service and method  name provided.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the objects retrieved from the service using the method</li>
				<li><span class="field">throws:</span> InvalidArgumentException if <var>$methodName</var> is not a      get*ByStatement method or the filterText contains the LIMIT or      OFFSET options</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">array</span>
		<span class="method-name">
			GetSomeObjects
		</span>
					(<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>&nbsp;<span class="var-name">$service</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$methodName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filterText</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../GoogleApiAdsDfp/Lib/DfpSoapClient.html">DfpSoapClient</a></span>
				<span class="var-name">$service</span><span class="var-description">: the service to use</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$methodName</span><span class="var-description">: the name of the method</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filterText</span><span class="var-description">: filter text</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constGET_BY_STATEMENT_METHOD_NAME_REGEX" id="GET_BY_STATEMENT_METHOD_NAME_REGEX"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">GET_BY_STATEMENT_METHOD_NAME_REGEX</span>
			 = <span class="const-default"> '/^get.*ByStatement$/'</span>
			(line <span class="line-number">43</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The regular expression used to determine if a method name is in the  format get*ByStatement.</p>
	
	
</div>
<a name="constINCOMPATIBLE_FILTER_TEXT_REGEX" id="INCOMPATIBLE_FILTER_TEXT_REGEX"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">INCOMPATIBLE_FILTER_TEXT_REGEX</span>
			 = <span class="const-default"><br />      '/(?i)(?&lt;=^|\s)(LIMIT|OFFSET)(?=$|\s)/'</span>
			(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The regular expression used to determine if the filter text is  incompatible.</p>
	
	
</div>
<a name="constPAGE_SIZE" id="PAGE_SIZE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">PAGE_SIZE</span>
			 = <span class="const-default"> 500</span>
			(line <span class="line-number">36</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The size of each page of results, as controlled by the LIMIT clause.</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>